Zapier 期望的响应类型
在每个 API 调用中,Zapier 期望响应数据以特定的响应类型返回,这取决于您正在处理的集成部分。请参考下表以确定正确的响应类型。
方法 | 响应类型 | 备注 |
---|---|---|
身份验证 | 对象 | 单个 JSON 格式的对象,包含 auth 方案的任何特定字段。 |
身份验证测试 | 对象 | 对象 |
触发器 | 数组 | JSON 格式的数组,按逆时间顺序排列结果。结果将被解析并进行去重处理。空数组不会触发任何操作。 |
创建操作 | 对象 | 对象中的各个字段将被解析,用于映射到后续 Zap 步骤中。 |
搜索操作 | 数组 | JSON 格式的数组,按最佳匹配优先排序,但不要限制为单个结果或将它们分组为一个组。如果未找到匹配项,返回 200 状态码并附带空数组。 |
注意:
- 如果您的应用 API 调用未返回响应,Zapier 将显示超时错误。
- 如果在您的集成中使用行项目,请注意并非所有 Zapier 集成都支持行项目。请使用表中推荐的响应类型,以降低用户需要重新格式化数据来用于其 Zap 的可能性。了解更多关于行项目在 Zap 中的工作原理的信息。
返回相关数据作为行项目
行项目用于呈现与单个事务相关的多个项目,例如订单或发票。要在操作中为用户返回行项目数据,您需要将要显示的多个项目作为对象数组返回,并在描述性键下组织。
例如,一个创建订单操作返回的订单(包含多个项目)可能如下所示:
order = {
name: 'Zap Zaplar',
total_cost: 25.96,
items: [
{
name: 'Zapier T-Shirt',
unit_price: 11.99,
quantity: 3,
line_amount: 35.97,
category: 'shirts'
},
{
name: 'Orange Widget',
unit_price: 7.99,
quantity: 10,
line_amount: 79.90,
category: 'widgets'
},
{
name: 'Stuff',
unit_price: 2.99,
quantity: 7,
line_amount: 20.93,
category: 'stuff'
},
{
name: 'Allbird Shoes',
unit_price: 2.99,
quantity: 7,
line_amount: 20.93,
category: 'shoes'
}
],
zip: 01002
}
返回多个项目作为搜索结果
不要使用行项目来分组搜索结果。尽管 Zap 默认只使用第一个结果,但用户可以选择将所有结果分组为行项目。其他产品(如 Agents)将始终使用所有结果。请不要将多个结果分组为行项目——而应让产品和用户自行控制这一点。